Skip to content

src: add setTitle() as alternative to direct assignment#62804

Open
JonathanLopes404 wants to merge 3 commits intonodejs:mainfrom
JonathanLopes404:fix/issue-62797
Open

src: add setTitle() as alternative to direct assignment#62804
JonathanLopes404 wants to merge 3 commits intonodejs:mainfrom
JonathanLopes404:fix/issue-62797

Conversation

@JonathanLopes404
Copy link
Copy Markdown

@JonathanLopes404 JonathanLopes404 commented Apr 18, 2026

Implement process.setTitle(title) as a new function-based API for setting the process title, complementing the existing process.title property assignment pattern

Fixes: #62797

@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

nodejs-github-bot commented Apr 18, 2026

Review requested:

  • @nodejs/startup

@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Apr 18, 2026
addaleax
addaleax requested changes Apr 18, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this introduce a new native method? Adding the new API is fine, but it should just trigger the same code paths.

@JonathanLopes404
Copy link
Copy Markdown
Author

JonathanLopes404 commented Apr 18, 2026

@addaleax Updated in latest commit: setTitle now reuses the existing process.title path (removed native method). Could you please take another look?

@addaleax addaleax added semver-minor PRs that contain new features and should be released in the next minor version. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Apr 19, 2026
@github-actions github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 19, 2026
@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

nodejs-github-bot commented Apr 19, 2026

CI: https://ci.nodejs.org/job/node-test-pull-request/72786/

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 19, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.62%. Comparing base (ecf3435) to head (685682f).
⚠️ Report is 11 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #62804   +/-   ##
=======================================
  Coverage   89.62%   89.62%           
=======================================
  Files         706      706           
  Lines      219137   219152   +15     
  Branches    41981    41988    +7     
=======================================
+ Hits       196397   196417   +20     
+ Misses      14632    14607   -25     
- Partials     8108     8128   +20
Files with missing lines Coverage Δ
...l/bootstrap/switches/does_not_own_process_state.js 100.00% <100.00%> (ø)
...ernal/bootstrap/switches/does_own_process_state.js 95.33% <100.00%> (+0.19%) ⬆️

... and 42 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@silverwind
Copy link
Copy Markdown
Contributor

silverwind commented Apr 19, 2026

Would add a reference on bottom of the process.title docs to point to the new alternative.

@JonathanLopes404
src: add setTitle() as alternative to direct assignment
5153b8b 
Implement process.setTitle(title) as a new function-based API for
setting the process title, complementing the existing process.title
property assignment pattern

Fixes: nodejs#62797
Signed-off-by: Jonathan Lopes <jonathan15989@protonmail.com>
@JonathanLopes404
src: add setTitle() api reusing process.title path
813e7b8 
Add process.setTitle(title) as a new API while reusing the existing
process.title assignment behavior instead of introducing a separate
native code path.

Signed-off-by: Jonathan Lopes <jonathan15989@protonmail.com>
@JonathanLopes404
doc: add process.setTitle() reference in process.title docs
685682f 
Add a cross-reference at the end of the process.title section to point
to process.setTitle() as the new alternative API.

Signed-off-by: Jonathan Lopes <jonathan15989@protonmail.com>
@ljharb
Copy link
Copy Markdown
Member

ljharb commented Apr 20, 2026

I'm confused why an alias for x => { process.title = x } is helpful - if it were an entirely new method, such that one could eventually deprecate the assignment form, that'd be one thing.

Separately, is it expected that if i Object.defineProperty(process, 'title', { writable: false, configurable: false }), setTitle will throw?

@JonathanLopes404
Copy link
Copy Markdown
Author

JonathanLopes404 commented Apr 21, 2026

Hello @ljharb,

Regarding the usefulness: the primary motivation is to support modern ESM usage. Since ESM bindings are read-only, users cannot do import { title } from 'node:process'; title = 'new'. By providing setTitle, we allow developers to use named exports effectively without needing to import the entire process object, which aligns with how other modern APIs are being shaped.

About Object.defineProperty:
Yes, it is expected to throw. Since wrappedSetTitle internally performs process.title = title, it will respect the property descriptors of process.title. If the property is made non-writable or non-configurable, the setter will throw a TypeError, maintaining consistency with the current behavior of the process object.

@silverwind
Copy link
Copy Markdown
Contributor

silverwind commented Apr 21, 2026

I checked if there are more similar APIs that would need similar treatment and process.title appears to be the only setter API in the whole Node API, so it's complete treatment for the topic.

A deprecation of process.title could also be considered, maybe not now, but for the future.

@ljharb
Copy link
Copy Markdown
Member

ljharb commented Apr 21, 2026

Fair point on the ESM usage.

ljharb
ljharb reviewed Apr 21, 2026
View reviewed changes
Comment thread lib/internal/bootstrap/switches/does_not_own_process_state.js
Comment thread lib/internal/bootstrap/switches/does_own_process_state.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ljharb ljharb ljharb approved these changes

@addaleax addaleax Awaiting requested review from addaleax

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. semver-minor PRs that contain new features and should be released in the next minor version.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Provide a process.setTitle() function

5 participants

@JonathanLopes404 @nodejs-github-bot @silverwind @ljharb @addaleax